fold() is a terminal operator: it does not return another Flow, but rather a result from operating on that Flow.

fold() takes an initial value (of some arbitrary type) and a lambda expression or other function type. For the first item emitted by the upstream Flow, fold() calls the lambda expression with the initial value and that emitted item, and fold() saves the value that the lambda expression evaluates to. For the second item emitted by the upstream Flow, fold() calls the lambda expression with the result of the first lambda expression, along with the second emitted item, and fold() saves the value from the lambda expression. This process continues with each emitted item, until the upstream Flow completes. At that point, fold() returns whatever the last lambda expression invocation evaluated to. If the upstream Flow completes without ever emitting anything, fold() returns the initial value, unmodified.

In this sample, we have a custom sum() operator that sums a Flow of Int values. We start with 0 and add each emitted value to the previous sum.

You can learn more about this in:
Tags:
A Conflated Channel A Fixed-Buffer Channel A Parallel Coroutine Sample A Sequential Coroutine Sample A Simple Channel A Simple Coroutine Sample A Simple Flow A Simple SharedFlow A Simple StateFlow A Zero-Buffer Channel async() BroadcastChannel cancelAndJoin() Canceling a Job Canceling a Parent Cancels Its Children Canceling and Cooperation catch() Channel and receive() Channels and Fan-out combine() Operator Contexts and Jobs Cooperation by Checking isActive Cooperation by Yielding debounce() Operator distinctUntilChanged() Operator distinctUntilChangedBy() Operator drop() Operator dropWhile() Operator filter() Operator filterIsInstance() Operator filterNot() Operator filterNotNull() Operator first() and Flow flattenConcat() Operator flattenMerge() Operator Flow Actions Flow onStart() flowOf() flowOn() Flows and Exceptions fold() Operator Hot Channels Via offer() invokeOnCompletion() Jobs and Parents Jobs Cancel When They Crash join() Lazy Coroutines map() Operator mapLatest() Operator mapNotNull() Operator Massively Parallel Coroutines MutableSharedFlow Replay Option Non-Cancellable Coroutines Parent Jobs Cancel When a Child Crashes promise() retry() retryWhen() runBlocking() sample() Operator scan() Operator single() and singleOrNull() Starting Lazy Coroutines StateFlow and Content Equality suspend Functions and Flows Suspending main() take() Operator takeWhile() Operator The Channel() Function TimeoutCancellationException Timeouts toList() and toSet() toList() for Channel withIndex() Operator withTimeoutOrNull() zip() Operator
A Simple Flow A Simple SharedFlow A Simple StateFlow catch() combine() Operator debounce() Operator distinctUntilChanged() Operator distinctUntilChangedBy() Operator drop() Operator dropWhile() Operator filter() Operator filterIsInstance() Operator filterNot() Operator filterNotNull() Operator first() and Flow flattenConcat() Operator flattenMerge() Operator Flow Actions Flow onStart() flowOf() flowOn() Flows and Exceptions fold() Operator map() Operator mapLatest() Operator mapNotNull() Operator MutableSharedFlow Replay Option retry() retryWhen() sample() Operator scan() Operator single() and singleOrNull() StateFlow and Content Equality suspend Functions and Flows take() Operator takeWhile() Operator toList() and toSet() withIndex() Operator zip() Operator
Run Edit